Add note about setting delay to zero

diff --git a/README.org b/README.org
index fc5ad99e99b956b303dd48bbfe05e05cc1c1bc43..31a3186bd2745152259abb5d3734ef8d598166f2 100644 (file)
--- a/README.org
+++ b/README.org
@@ -386,7 +386,8 @@ The options below are also available through customize. Their defaults are
 shown.
 
 #+BEGIN_SRC emacs-lisp
-  ;; Set the time delay (in seconds) for the which-key popup to appear.
+  ;; Set the time delay (in seconds) for the which-key popup to appear. A value of
+  ;; zero might cause issues so a non-zero value is recommended.
   (setq which-key-idle-delay 1.0)
 
   ;; Set the maximum length (in characters) for key descriptions (commands or

diff --git a/which-key.el b/which-key.el
index ccac5ce50f8672a08ec43544949249628cbe9510..114b04dae3a9bb0933842589cb1fe1b79852f0bd 100644 (file)
--- a/which-key.el
+++ b/which-key.el
@@ -54,7 +54,9 @@
   :prefix "which-key-")
 
 (defcustom which-key-idle-delay 1.0
-  "Delay (in seconds) for which-key buffer to popup."
+  "Delay (in seconds) for which-key buffer to popup. A value of zero
+might lead to issues, so a non-zero value is recommended
+(see https://github.com/justbur/emacs-which-key/issues/134)."
   :group 'which-key
   :type 'float)